Show:

ia.NumericClassifier Class

Defined in: ia\thematics\NumericClassifier.js:1
Module: ia

Classifies numeric data.

Constructor

ia.NumericClassifier

(
  • data
)

Defined in ia\thematics\NumericClassifier.js:1

Parameters:

  • data Number

    The data array.

Methods

_adjustBreak

(
  • formattedValue
)
Number private

Defined in ia\thematics\NumericClassifier.js:321

Adjusts a break for a range class.

Parameters:

  • formattedValue String

    The formatted value

Returns:

Number: The adjusted value.

_buildClasses

(
  • p
)
private

Defined in ia\thematics\NumericClassifier.js:217

Rebuilds the classes.

Parameters:

  • p Number

    An optional precision.

_buildPalettes

() private

Defined in ia\thematics\NumericClassifier.js:354

Rebuilds the breaks.

commitChanges

()

Defined in ia\thematics\NumericClassifier.js:187

Call this to commit any changes.

getBreaks

() Number

Defined in ia\thematics\NumericClassifier.js:154

The list of breaks

Returns:

Number: The breaks.

getCalculator

() ia.Calculator

Defined in ia\thematics\NumericClassifier.js:165

Used for calculating the breaks.

Returns:

ia.Calculator: The calculator.

getClass

(
  • value
)
ia.NumberClass

Defined in ia\thematics\NumericClassifier.js:198

Gets the legend class for the given value.

Parameters:

  • value Number

    The value.

Returns:

ia.NumberClass: The legend class that contains the value.

getClasses

() ia.NumberClass[]

Defined in ia\thematics\NumericClassifier.js:176

An array of legend classes contained in the classifier.

Returns:

ia.NumberClass[]: The classes.

getData

() Number

Defined in ia\thematics\NumericClassifier.js:131

Gets the data.

Returns:

Number: The data.

setData

(
  • value
)

Defined in ia\thematics\NumericClassifier.js:142

Sets the data.

Parameters:

  • value Number

    The data.

Properties

classificationName

String

Defined in ia\thematics\NumericClassifier.js:60

The name of the classification to use when calculating breaks.

Possible values include:

  • ia.Thematic.CONTINUOUS
  • ia.Thematic.EQUAL_INTERVAL
  • ia.Thematic.QUANTILE
  • ia.Thematic.NATURAL
  • ia.Thematic.STANDARD_DEVIATION

Default: ia.Thematic.EQUAL_INTERVAL

colorPalette

ia.ColorPalette

Defined in ia\thematics\NumericClassifier.js:44

Used to classify colors.

formatter

ia.Formatter

Defined in ia\thematics\NumericClassifier.js:36

The formatter.

labels

String

Defined in ia\thematics\NumericClassifier.js:79

A list of labels used in place of the default values.

maxRule

String

Defined in ia\thematics\NumericClassifier.js:122

The maximum rule classes. Valid rules are "<=" or "<".

Default: "<="

minRule

String

Defined in ia\thematics\NumericClassifier.js:113

The minimum rule for range classes. Valid rules are ">=" or ">".

Default: ">="

noClasses

Number

Defined in ia\thematics\NumericClassifier.js:96

The number of classes to calculate breaks for.

Default: 5

precision

Number

Defined in ia\thematics\NumericClassifier.js:105

The precision.

sdLabels

String

Defined in ia\thematics\NumericClassifier.js:87

The list of standard deviation labels.

Default: ["> 2 SD below mean","1 - 2 SD below mean","0 - 1 SD below mean","0 - 1 SD above mean","1 - 2 SD above mean","> 2 SD above mean"]

sizePalette

ia.SizePalette

Defined in ia\thematics\NumericClassifier.js:52

Used to classify sizes.